| Contacts |
| Get Contacts |
/contacts/ |
GET
|
|
|
| Create Contact |
/contacts/ |
POST
|
| Request Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Get Contact |
/contacts/{contact_id}/ |
GET
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Update Contact |
/contacts/{contact_id}/ |
PUT
|
| Request Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Delete Contact |
/contacts/{contact_id}/ |
DELETE
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Contact - Phones |
| Get Phones |
/contacts/{contact_id}/phones/ |
GET
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Add Phone |
/contacts/{contact_id}/phones/ |
POST
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Get Phone |
/contacts/{contact_id}/phones/{phone_id}/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Update Phone |
/contacts/{contact_id}/phones/{phone_id}/ |
PUT
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Delete Phone |
/contacts/{contact_id}/phones/{phone_id}/ |
DELETE
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Locations |
| Get Locations |
/locations/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Add Location |
/locations/ |
POST
|
| Request Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Get Location |
/locations/{location_id}/ |
GET
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Update Location |
/locations/{location_id}/ |
UPDATE
|
| Request Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Delete Location |
/locations/{location_id}/ |
DELETE
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Location - Holiday Schedule |
| Get Holiday Schedule |
/locations/{location_id}/holiday_schedule/ |
GET
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Add Holiday Schedule |
/locations/{location_id}/holiday_schedule/ |
POST
|
| Request Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Get Holiday Schedule |
/locations/{location_id}/holiday_schedule/{holiday_schedule_id}/ |
GET
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Update Holiday Schedule |
/locations/{location_id}/holiday_schedule/{holiday_schedule_id}/ |
PUT
|
| Request Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Delete Holiday Schedule |
/locations/{location_id}/holiday_schedule/{holiday_schedule_id}/ |
DELETE
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Location - Language |
| Get Languages |
/locations/{location_id}/languages/ |
GET
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Add Languages |
/locations/{location_id}/languages/ |
POST
|
| Request Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Get Languages |
/locations/{location_id}/languages/{language_id}/ |
GET
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Update Languages |
/locations/{location_id}/languages/{language_id}/ |
PUT
|
| Request Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Delete Languages |
/locations/{location_id}/languages/{language_id}/ |
DELETE
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Location - Postal Address |
| Get Postal Address |
/locations/{location_id}/postal_address/ |
GET
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Add New Postal Adress |
/locations/{location_id}/postal_address/ |
POST
|
| Request Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Get Postal Address |
/locations/{location_id}/postal_address/{postal_address_id}/ |
GET
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Update Postal Address |
/locations/{location_id}/postal_address/{postal_address_id}/ |
PUT
|
| Request Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Delete Postal Address |
/locations/{location_id}/postal_address/{postal_address_id}/ |
DELETE
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Location - Physical Address |
| Get Physical Address |
/locations/{location_id}/physical_address/ |
GET
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Add New Physical Adress |
/locations/{location_id}/physical_address/ |
POST
|
| Request Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Get Physical Address |
/locations/{location_id}/physical_address/{postal_address_id}/ |
GET
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Update Physical Address |
/locations/{location_id}/physical_address/{postal_address_id}/ |
PUT
|
| Request Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Delete Physical Address |
/locations/{location_id}/physical_address/{postal_address_id}/ |
DELETE
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Location - Phones |
| Get Phones |
/locations/{location_id}/phones/ |
GET
|
| Reponse Body: (postal_address) |
| id |
Each postal address must have a unique identifier. |
| location_id |
The identifier of the location for which this is the postal address. |
| attention |
The person or entity for whose attention mail should be marked. |
| address_1 |
The first line of the address. |
| address_2 |
The second line of the address. |
| address_3 |
The third line of the address. |
| address_4 |
The fourth line of the address. |
| city |
The city in which the address is located. |
| state_province |
The state or province in which the address is located. |
| postal_code |
The postal code for the address. |
| country |
The country in which the address is located. |
|
|
| Add Phone |
/locations/{location_id}/phones/ |
POST
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Get Phone |
/locations/{location_id}/phones/{phone_id}/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Update Phone |
/locations/{location_id}/phones/{phone_id}/ |
PUT
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Delete Phone |
/locations/{location_id}/phones/{phone_id}/ |
DELETE
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Location - Regular Schedule |
| Get Regular Schedule |
/locations/{location_id}/regular_schedule/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Add Regular Schedule |
/locations/{location_id}/regular_schedule/ |
POST
|
| Request Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Get Regular Schedule |
/locations/{location_id}/regular_schedule/{regular_schedule_id}/ |
GET
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Update Regular Schedule |
/locations/{location_id}/regular_schedule/{regular_schedule_id}/ |
PUT
|
| Request Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Delete Regular Schedule |
/locations/{location_id}/regular_schedule/{regular_schedule_id}/ |
DELETE
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Location - Services |
| Get Service |
/locations/{location_id}/services/ |
GET
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Add Service |
/locations/{location_id}/services/ |
POST
|
| Request Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Get Service |
/locations/{location_id}/services/{service_id}/ |
GET
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Update Service |
/locations/{location_id}/services/{service_id}/ |
PUT
|
| Request Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Delete Service |
/locations/{location_id}/services/{service_id}/ |
DELETE
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Location - Accessibility For Disabilities |
| Get Accessibility For Disabilities |
/locations/{location_id}/accessibility_for_disabilities/ |
GET
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Add Accessibility For Disabilities |
/locations/{location_id}/accessibility_for_disabilities/ |
POST
|
| Request Body: (accessibility_for_disabilities) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location for which the entry describes the accessibility provision. |
| accessibility |
Description of assistance or infrastructure that facilitate access to clients with disabilities. |
|
| Reponse Body: (accessibility_for_disabilities) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location for which the entry describes the accessibility provision. |
| accessibility |
Description of assistance or infrastructure that facilitate access to clients with disabilities. |
|
|
| Get Accessibility For Disabilities |
/locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/ |
GET
|
| Reponse Body: (accessibility_for_disabilities) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location for which the entry describes the accessibility provision. |
| accessibility |
Description of assistance or infrastructure that facilitate access to clients with disabilities. |
|
|
| Update Accessibility For Disabilities |
/locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/ |
PUT
|
| Request Body: (accessibility_for_disabilities) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location for which the entry describes the accessibility provision. |
| accessibility |
Description of assistance or infrastructure that facilitate access to clients with disabilities. |
|
| Reponse Body: (accessibility_for_disabilities) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location for which the entry describes the accessibility provision. |
| accessibility |
Description of assistance or infrastructure that facilitate access to clients with disabilities. |
|
|
| Delete Accessibility For Disabilities |
/locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/ |
DELETE
|
| Reponse Body: (accessibility_for_disabilities) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location for which the entry describes the accessibility provision. |
| accessibility |
Description of assistance or infrastructure that facilitate access to clients with disabilities. |
|
|
| Metadata |
| Get Metadata |
/metadata/ |
GET
|
| Reponse Body: (accessibility_for_disabilities) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location for which the entry describes the accessibility provision. |
| accessibility |
Description of assistance or infrastructure that facilitate access to clients with disabilities. |
|
|
| Add New Metadata |
/metadata/ |
POST
|
| Request Body: (metadata) |
| id |
Each entry must have a unique identifier. |
| resource_id |
Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs. |
| last_action_date |
The date when data was changed. |
| last_action_type |
The kind of change made to the data; eg create, update, delete. |
| field_name |
The name of field that has been modified. |
| previous_value |
The previous value of a field that has been updated. |
| replacement_value |
The new value of a field that has been updated. |
| updated_by |
The name of the person who updated a value. |
|
| Reponse Body: (metadata) |
| id |
Each entry must have a unique identifier. |
| resource_id |
Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs. |
| last_action_date |
The date when data was changed. |
| last_action_type |
The kind of change made to the data; eg create, update, delete. |
| field_name |
The name of field that has been modified. |
| previous_value |
The previous value of a field that has been updated. |
| replacement_value |
The new value of a field that has been updated. |
| updated_by |
The name of the person who updated a value. |
|
|
| Get Service |
/metadata/{metadata_id}/ |
GET
|
| Reponse Body: (metadata) |
| id |
Each entry must have a unique identifier. |
| resource_id |
Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs. |
| last_action_date |
The date when data was changed. |
| last_action_type |
The kind of change made to the data; eg create, update, delete. |
| field_name |
The name of field that has been modified. |
| previous_value |
The previous value of a field that has been updated. |
| replacement_value |
The new value of a field that has been updated. |
| updated_by |
The name of the person who updated a value. |
|
|
| Delete Metadata |
/metadata/{metadata_id}/ |
DELETE
|
| Reponse Body: (metadata) |
| id |
Each entry must have a unique identifier. |
| resource_id |
Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs. |
| last_action_date |
The date when data was changed. |
| last_action_type |
The kind of change made to the data; eg create, update, delete. |
| field_name |
The name of field that has been modified. |
| previous_value |
The previous value of a field that has been updated. |
| replacement_value |
The new value of a field that has been updated. |
| updated_by |
The name of the person who updated a value. |
|
|
| Organizations |
| Get Locations |
/organizations/ |
GET
|
| Reponse Body: (metadata) |
| id |
Each entry must have a unique identifier. |
| resource_id |
Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs. |
| last_action_date |
The date when data was changed. |
| last_action_type |
The kind of change made to the data; eg create, update, delete. |
| field_name |
The name of field that has been modified. |
| previous_value |
The previous value of a field that has been updated. |
| replacement_value |
The new value of a field that has been updated. |
| updated_by |
The name of the person who updated a value. |
|
|
| Create a new organization |
/organizations/ |
POST
|
| Request Body: (organization) |
| id |
Each organization must have a unique identifier. |
| name |
The official or public name of the organization. |
| alternate_name |
Alternative or commonly used name for the organization. |
| description |
A brief summary about the organization. It can contain markup such as HTML or Markdown. |
| email |
The contact e-mail address for the organization. |
| url |
The URL (website address) of the organization. |
| tax_status |
Government assigned tax designation for for tax-exempt organizations. |
| tax_id |
A government issued identifier used for the purpose of tax administration. |
| year_incorporated |
The year in which the organization was legally formed. |
| legal_status |
The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. |
|
| Reponse Body: (organization) |
| id |
Each organization must have a unique identifier. |
| name |
The official or public name of the organization. |
| alternate_name |
Alternative or commonly used name for the organization. |
| description |
A brief summary about the organization. It can contain markup such as HTML or Markdown. |
| email |
The contact e-mail address for the organization. |
| url |
The URL (website address) of the organization. |
| tax_status |
Government assigned tax designation for for tax-exempt organizations. |
| tax_id |
A government issued identifier used for the purpose of tax administration. |
| year_incorporated |
The year in which the organization was legally formed. |
| legal_status |
The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. |
|
|
| Get Organization |
/organizations/{organization_id}/ |
GET
|
| Reponse Body: (organization) |
| id |
Each organization must have a unique identifier. |
| name |
The official or public name of the organization. |
| alternate_name |
Alternative or commonly used name for the organization. |
| description |
A brief summary about the organization. It can contain markup such as HTML or Markdown. |
| email |
The contact e-mail address for the organization. |
| url |
The URL (website address) of the organization. |
| tax_status |
Government assigned tax designation for for tax-exempt organizations. |
| tax_id |
A government issued identifier used for the purpose of tax administration. |
| year_incorporated |
The year in which the organization was legally formed. |
| legal_status |
The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. |
|
|
| Update Existing Organization |
/organizations/{organization_id}/ |
PUT
|
| Request Body: (organization) |
| id |
Each organization must have a unique identifier. |
| name |
The official or public name of the organization. |
| alternate_name |
Alternative or commonly used name for the organization. |
| description |
A brief summary about the organization. It can contain markup such as HTML or Markdown. |
| email |
The contact e-mail address for the organization. |
| url |
The URL (website address) of the organization. |
| tax_status |
Government assigned tax designation for for tax-exempt organizations. |
| tax_id |
A government issued identifier used for the purpose of tax administration. |
| year_incorporated |
The year in which the organization was legally formed. |
| legal_status |
The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. |
|
| Reponse Body: (organization) |
| id |
Each organization must have a unique identifier. |
| name |
The official or public name of the organization. |
| alternate_name |
Alternative or commonly used name for the organization. |
| description |
A brief summary about the organization. It can contain markup such as HTML or Markdown. |
| email |
The contact e-mail address for the organization. |
| url |
The URL (website address) of the organization. |
| tax_status |
Government assigned tax designation for for tax-exempt organizations. |
| tax_id |
A government issued identifier used for the purpose of tax administration. |
| year_incorporated |
The year in which the organization was legally formed. |
| legal_status |
The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. |
|
|
| Delete Organization |
/organizations/{organization_id}/ |
DELETE
|
| Reponse Body: (organization) |
| id |
Each organization must have a unique identifier. |
| name |
The official or public name of the organization. |
| alternate_name |
Alternative or commonly used name for the organization. |
| description |
A brief summary about the organization. It can contain markup such as HTML or Markdown. |
| email |
The contact e-mail address for the organization. |
| url |
The URL (website address) of the organization. |
| tax_status |
Government assigned tax designation for for tax-exempt organizations. |
| tax_id |
A government issued identifier used for the purpose of tax administration. |
| year_incorporated |
The year in which the organization was legally formed. |
| legal_status |
The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. |
|
|
| Organization - Contacts |
| Get Contacts |
/organizations/{organization_id}/contacts/ |
GET
|
| Reponse Body: (organization) |
| id |
Each organization must have a unique identifier. |
| name |
The official or public name of the organization. |
| alternate_name |
Alternative or commonly used name for the organization. |
| description |
A brief summary about the organization. It can contain markup such as HTML or Markdown. |
| email |
The contact e-mail address for the organization. |
| url |
The URL (website address) of the organization. |
| tax_status |
Government assigned tax designation for for tax-exempt organizations. |
| tax_id |
A government issued identifier used for the purpose of tax administration. |
| year_incorporated |
The year in which the organization was legally formed. |
| legal_status |
The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization. |
|
|
| Add Contact |
/organizations/{organization_id}/contacts/ |
POST
|
| Request Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Get Contact |
/organizations/{organization_id}/contacts/{contact_id}/ |
GET
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Update Contact |
/organizations/{organization_id}/contacts/{contact_id}/ |
PUT
|
| Request Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Delete Contact |
/organizations/{organization_id}/contacts/{contact_id}/ |
DELETE
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Organization - Funding |
| Get Funding |
/organizations/{organization_id}/funding/ |
GET
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Add Funding |
/organizations/{organization_id}/funding/ |
POST
|
| Request Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Get Funding |
/organizations/{organization_id}/funding/{funding_id}/ |
GET
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Update Funding |
/organizations/{organization_id}/funding/{funding_id}/ |
PUT
|
| Request Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Delete Funding |
/organizations/{organization_id}/funding/{funding_id}/ |
DELETE
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Organization - Locations |
| Get Location |
/organizations/{organization_id}/locations/ |
GET
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Create a new location |
/organizations/{organization_id}/locations/ |
POST
|
| Request Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Update Existing Location |
/organizations/{organization_id}/locations/{location_id}/ |
GET
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Create a new location |
/organizations/{organization_id}/locations/{location_id}/ |
PUT
|
| Request Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Delete Location |
/organizations/{organization_id}/locations/{location_id}/ |
DELETE
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Organization - Phones |
| Get Phones |
/organizations/{organization_id}/phones/ |
GET
|
| Reponse Body: (location) |
| id |
Each location must have a unique identifier. |
| organization_id |
Each location must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the location. |
| alternate_name |
An alternative name for the location. |
| description |
A description of this location. |
| transportation |
A description of the access to public or private transportation to and from the location. |
| latitude |
Y coordinate of location expressed in decimal degrees in WGS84 datum. |
| longitude |
X coordinate of location expressed in decimal degrees in WGS84 datum. |
|
|
| Add Phone |
/organizations/{organization_id}/phones/ |
POST
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Get Phone |
/organizations/{organization_id}/phones/{phone_id}/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Update Phone |
/organizations/{organization_id}/phones/{phone_id}/ |
PUT
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Delete Phone |
/organizations/{organization_id}/phones/{phone_id}/ |
DELETE
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Organization - Programs |
| Get Programs |
/organizations/{organization_id}/programs/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Add Program |
/organizations/{organization_id}/programs/ |
POST
|
| Request Body: (program) |
| id |
Each program must have a unique identifier. |
| organization_id |
Each program must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the program. |
| alternate_name |
NeAn alternative name for the program. |
|
| Reponse Body: (program) |
| id |
Each program must have a unique identifier. |
| organization_id |
Each program must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the program. |
| alternate_name |
NeAn alternative name for the program. |
|
|
| Get Program |
/organizations/{organization_id}/programs/{program_id}/ |
GET
|
| Reponse Body: (program) |
| id |
Each program must have a unique identifier. |
| organization_id |
Each program must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the program. |
| alternate_name |
NeAn alternative name for the program. |
|
|
| Update Program |
/organizations/{organization_id}/programs/{program_id}/ |
PUT
|
| Request Body: (program) |
| id |
Each program must have a unique identifier. |
| organization_id |
Each program must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the program. |
| alternate_name |
NeAn alternative name for the program. |
|
| Reponse Body: (program) |
| id |
Each program must have a unique identifier. |
| organization_id |
Each program must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the program. |
| alternate_name |
NeAn alternative name for the program. |
|
|
| Delete Program |
/organizations/{organization_id}/programs/{program_id}/ |
DELETE
|
| Reponse Body: (program) |
| id |
Each program must have a unique identifier. |
| organization_id |
Each program must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the program. |
| alternate_name |
NeAn alternative name for the program. |
|
|
| Organization - Program Services |
| Get Service |
/organizations/{organization_id}/programs/{program_id}/services/ |
GET
|
| Reponse Body: (program) |
| id |
Each program must have a unique identifier. |
| organization_id |
Each program must belong to a single organization. The identifier of the organization should be given here. |
| name |
The name of the program. |
| alternate_name |
NeAn alternative name for the program. |
|
|
| Add Service |
/organizations/{organization_id}/programs/{program_id}/services/ |
POST
|
| Request Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Get Service |
/organizations/{organization_id}/programs/{program_id}/services/{service_id}/ |
GET
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Update Service |
/organizations/{organization_id}/programs/{program_id}/services/{service_id}/ |
PUT
|
| Request Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Delete Service |
/organizations/{organization_id}/programs/{program_id}/services/{service_id}/ |
DELETE
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Organization - Services |
| Get Services |
/organizations/{organization_id}/services/ |
GET
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Add Service |
/organizations/{organization_id}/services/ |
POST
|
| Request Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Get Service |
/organizations/{organization_id}/services/{service_id}/ |
GET
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Update Service |
/organizations/{organization_id}/services/{service_id}/ |
PUT
|
| Request Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Delete Service |
/organizations/{organization_id}/services/{service_id}/ |
DELETE
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Search |
| Get locations that match certain criteria. |
/search/ |
GET
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Service - Contacts |
| Get Contacts |
/services/{service_id}/contacts/ |
GET
|
| Reponse Body: (service) |
| id |
Each service must have a unique identifier. |
| organization_id |
The identifier of the organization that provides this service. |
| program_id |
The identifier of the program this service is delivered under. |
| location_id |
The identifier of the location where this service is delivered. |
| name |
The official or public name of the service. |
| alternate_name |
Alternative or commonly used name for a service. |
| description |
A description of the service. |
| url |
URL of the service. |
| email |
Email address for the service. |
| status |
The current status of the service. |
| application_process |
The steps needed to access the service. |
| wait_time |
Time a client may expect to wait before receiving a service. |
| taxonomy_ids |
A comma separated list of identifiers from the taxonomy table. |
|
|
| Add Contact |
/services/{service_id}/contacts/ |
POST
|
| Request Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Get Contact |
/services/{service_id}/contacts/{contact_id}/ |
GET
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Update Contact |
/services/{service_id}/contacts/{contact_id}/ |
PUT
|
| Request Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Delete Contact |
/services/{service_id}/contacts/{contact_id}/ |
DELETE
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Service - Eligibility |
| Get Eligibility |
/services/{service_id}/eligibility/ |
GET
|
| Reponse Body: (contact) |
| id |
Each contact must have a unique identifier. |
| organization_id |
The identifier of the organization for which this is a contact. |
| service_id |
The identifier of the service for which this is a contact. |
| name |
The name of the person. |
| title |
The job title of the person. |
| department |
The department that the person is part of. |
| email |
The email address of the person. |
|
|
| Add Eligibility |
/services/{service_id}/eligibility/ |
POST
|
| Request Body: (eligibility) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the eligibility criteria. |
| eligibility |
The rules or guidelines that determine who can receive the service. |
|
| Reponse Body: (eligibility) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the eligibility criteria. |
| eligibility |
The rules or guidelines that determine who can receive the service. |
|
|
| Get Eligibility |
/services/{service_id}/eligibility/{eligibility_id}/ |
GET
|
| Reponse Body: (eligibility) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the eligibility criteria. |
| eligibility |
The rules or guidelines that determine who can receive the service. |
|
|
| Update Eligibility |
/services/{service_id}/eligibility/{eligibility_id}/ |
PUT
|
| Request Body: (eligibility) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the eligibility criteria. |
| eligibility |
The rules or guidelines that determine who can receive the service. |
|
| Reponse Body: (eligibility) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the eligibility criteria. |
| eligibility |
The rules or guidelines that determine who can receive the service. |
|
|
| Eligibility Contact |
/services/{service_id}/eligibility/{eligibility_id}/ |
DELETE
|
| Reponse Body: (eligibility) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the eligibility criteria. |
| eligibility |
The rules or guidelines that determine who can receive the service. |
|
|
| Service - Fees |
| Get Fees |
/services/{service_id}/fees/ |
GET
|
| Reponse Body: (eligibility) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the eligibility criteria. |
| eligibility |
The rules or guidelines that determine who can receive the service. |
|
|
| Add Fees |
/services/{service_id}/fees/ |
POST
|
| Request Body: (fee) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the costs of service. |
| fee |
A listing of the costs of services, including free ones. |
|
| Reponse Body: (fee) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the costs of service. |
| fee |
A listing of the costs of services, including free ones. |
|
|
| Get Fees |
/services/{service_id}/fees/{feed_id}/ |
GET
|
| Reponse Body: (fee) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the costs of service. |
| fee |
A listing of the costs of services, including free ones. |
|
|
| Update Fees |
/services/{service_id}/fees/{feed_id}/ |
PUT
|
| Request Body: (fee) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the costs of service. |
| fee |
A listing of the costs of services, including free ones. |
|
| Reponse Body: (fee) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the costs of service. |
| fee |
A listing of the costs of services, including free ones. |
|
|
| Eligibility Fees |
/services/{service_id}/fees/{feed_id}/ |
DELETE
|
| Reponse Body: (fee) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the costs of service. |
| fee |
A listing of the costs of services, including free ones. |
|
|
| Service - Funding |
| Get Funding |
/services/{service_id}/funding/ |
GET
|
| Reponse Body: (fee) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the costs of service. |
| fee |
A listing of the costs of services, including free ones. |
|
|
| Add Funding |
/services/{service_id}/funding/ |
POST
|
| Request Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Get Funding |
/services/{service_id}/funding/{funding_id}/ |
GET
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Update Funding |
/services/{service_id}/funding/{funding_id}/ |
PUT
|
| Request Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Delete Funding |
/services/{service_id}/funding/{funding_id}/ |
DELETE
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Service - Holiday Schedule |
| Get Holiday Schedule |
/services/{service_id}/holiday_schedule/ |
GET
|
| Reponse Body: (funding) |
| id |
Each entry must have a unique identifier. |
| organization_id |
The identifier of the organization for which this entry describes the source of funding. |
| service_id |
The identifier of the service for which this entry describes the source of funding. |
| source |
Source of funds for organization or service. |
|
|
| Add Holiday Schedule |
/services/{service_id}/holiday_schedule/ |
POST
|
| Request Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Get Holiday Schedule |
/services/{service_id}/holiday_schedule/{holiday_schedule_id}/ |
GET
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Update Holiday Schedule |
/services/{service_id}/holiday_schedule/{holiday_schedule_id}/ |
PUT
|
| Request Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Delete Holiday Schedule |
/services/{service_id}/holiday_schedule/{holiday_schedule_id}/ |
DELETE
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Service - Interpretation Services |
| Get Interpretation Services |
/services/{service_id}/intepretation_services/ |
GET
|
| Reponse Body: (holiday_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the holiday schedule. |
| location_id |
The identifier of the location for which this is the holiday schedule. |
| closed |
Indicates if a service or location is closed during a public holiday. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| start_date |
The first day that a service or location is closed during a public or private holiday. |
| end_date |
The last day that a service or location is closed during a public or private holiday. |
|
|
| Add Interpretation Services |
/services/{service_id}/intepretation_services/ |
POST
|
| Request Body: (intepretation_services) |
| id |
Each service must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the interpretation services available. |
| language |
Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes. |
|
| Reponse Body: (intepretation_services) |
| id |
Each service must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the interpretation services available. |
| language |
Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes. |
|
|
| Get Interpretation Services |
/services/{service_id}/intepretation_services/{intepretation_services_id}/ |
GET
|
| Reponse Body: (intepretation_services) |
| id |
Each service must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the interpretation services available. |
| language |
Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes. |
|
|
| Update Interpretation Services |
/services/{service_id}/intepretation_services/{intepretation_services_id}/ |
PUT
|
| Request Body: (intepretation_services) |
| id |
Each service must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the interpretation services available. |
| language |
Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes. |
|
| Reponse Body: (intepretation_services) |
| id |
Each service must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the interpretation services available. |
| language |
Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes. |
|
|
| Delete Interpretation Services |
/services/{service_id}/intepretation_services/{intepretation_services_id}/ |
DELETE
|
| Reponse Body: (intepretation_services) |
| id |
Each service must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the interpretation services available. |
| language |
Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes. |
|
|
| Service - Languages |
| Get Languages |
/services/{service_id}/languages/ |
GET
|
| Reponse Body: (intepretation_services) |
| id |
Each service must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the interpretation services available. |
| language |
Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes. |
|
|
| Add Languages |
/services/{service_id}/languages/ |
POST
|
| Request Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Get Languages |
/services/{service_id}/languages/{language_id}/ |
GET
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Update Languages |
/services/{service_id}/languages/{language_id}/ |
PUT
|
| Request Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Delete Languages |
/services/{service_id}/languages/{language_id}/ |
DELETE
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Service - Payment Accepted |
| Get Payment Accepted |
/services/{service_id}/payment_accepted/ |
GET
|
| Reponse Body: (language) |
| id |
Each language must have a unique identifier. |
| service_id |
The identifier of the service for which the entry describes the languages in which services are delivered. |
| location_id |
The identifier of the location for which the entry describes the languages in which services are delivered. |
| language |
Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes.. |
|
|
| Add Payment Accepted |
/services/{service_id}/payment_accepted/ |
POST
|
| Request Body: (payment_accepted) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the accepted payment methods. |
| payment |
The methods of payment accepted for the service. |
|
| Reponse Body: (payment_accepted) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the accepted payment methods. |
| payment |
The methods of payment accepted for the service. |
|
|
| Get Payment Accepted |
/services/{service_id}/payment_accepted/{payment_accepted_id}/ |
GET
|
| Reponse Body: (payment_accepted) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the accepted payment methods. |
| payment |
The methods of payment accepted for the service. |
|
|
| Update Payment Accepted |
/services/{service_id}/payment_accepted/{payment_accepted_id}/ |
PUT
|
| Request Body: (payment_accepted) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the accepted payment methods. |
| payment |
The methods of payment accepted for the service. |
|
| Reponse Body: (payment_accepted) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the accepted payment methods. |
| payment |
The methods of payment accepted for the service. |
|
|
| Delete Payment Accepted |
/services/{service_id}/payment_accepted/{payment_accepted_id}/ |
DELETE
|
| Reponse Body: (payment_accepted) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the accepted payment methods. |
| payment |
The methods of payment accepted for the service. |
|
|
| Service - Phones |
| Get Phones |
/services/{service_id}/phones/ |
GET
|
| Reponse Body: (payment_accepted) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the services for which the entry describes the accepted payment methods. |
| payment |
The methods of payment accepted for the service. |
|
|
| Add Phone |
/services/{service_id}/phones/ |
POST
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Get Phone |
/services/{service_id}/phones/{phone_id}/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Update Phone |
/services/{service_id}/phones/{phone_id}/ |
PUT
|
| Request Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Delete Phone |
/services/{service_id}/phones/{phone_id}/ |
DELETE
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Service - Regular Schedule |
| Get Regular Schedule |
/services/{service_id}/regular_schedule/ |
GET
|
| Reponse Body: (phone) |
| id |
Each entry must have a unique identifier. |
| location_id |
The identifier of the location where this phone number is located. |
| service_id |
The identifier of the service for which this is the phone number. |
| organization_id |
The identifier of the organisation for which this is the phone number. |
| contact_id |
The identifier of the contact for which this is the phone number. |
| number |
The phone number. |
| extension |
The extension of the phone number. |
| type |
Whether the phone number relates to a fixed or cellular phone. |
| department |
The department for which this is the phone number. |
|
|
| Add Regular Schedule |
/services/{service_id}/regular_schedule/ |
POST
|
| Request Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Get Regular Schedule |
/services/{service_id}/regular_schedule/{required_document_id}/ |
GET
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Update Regular Schedule |
/services/{service_id}/regular_schedule/{required_document_id}/ |
PUT
|
| Request Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Delete Regular Schedule |
/services/{service_id}/regular_schedule/{required_document_id}/ |
DELETE
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Service - Required Document |
| Get Required Document |
/services/{service_id}/required_document/ |
GET
|
| Reponse Body: (regular_schedule) |
| id |
Each entry must have a unique identifier. |
| service_id |
The identifier of the service for which this is the regular schedule. |
| location_id |
The identifier of the location for which this is the regular schedule. |
| weekday |
The day of the week that this entry relates to. |
| opens_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
| closes_at |
The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. |
|
|
| Add Required Document |
/services/{service_id}/required_document/ |
POST
|
| Request Body: (required_document) |
| id |
Each document must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the required document. |
| document |
The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport. |
|
| Reponse Body: (required_document) |
| id |
Each document must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the required document. |
| document |
The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport. |
|
|
| Get Required Document |
/services/{service_id}/required_document/{required_document_id}/ |
GET
|
| Reponse Body: (required_document) |
| id |
Each document must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the required document. |
| document |
The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport. |
|
|
| Update Required Document |
/services/{service_id}/required_document/{required_document_id}/ |
PUT
|
| Request Body: (required_document) |
| id |
Each document must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the required document. |
| document |
The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport. |
|
| Reponse Body: (required_document) |
| id |
Each document must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the required document. |
| document |
The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport. |
|
|
| Delete Required Document |
/services/{service_id}/required_document/{required_document_id}/ |
DELETE
|
| Reponse Body: (required_document) |
| id |
Each document must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the required document. |
| document |
The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport. |
|
|
| Service - Areas |
| Get Service Area |
/services/{service_id}/service_area/ |
GET
|
| Reponse Body: (required_document) |
| id |
Each document must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the required document. |
| document |
The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport. |
|
|
| Add Service Area |
/services/{service_id}/service_area/ |
POST
|
| Request Body: (service_area) |
| id |
Each service area must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the service area. |
| service_area |
The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary. |
|
| Reponse Body: (service_area) |
| id |
Each service area must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the service area. |
| service_area |
The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary. |
|
|
| Get Service Area |
/services/{service_id}/service_area/{service_area_id}/ |
GET
|
| Reponse Body: (service_area) |
| id |
Each service area must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the service area. |
| service_area |
The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary. |
|
|
| Update Service Area |
/services/{service_id}/service_area/{service_area_id}/ |
PUT
|
| Request Body: (service_area) |
| id |
Each service area must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the service area. |
| service_area |
The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary. |
|
| Reponse Body: (service_area) |
| id |
Each service area must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the service area. |
| service_area |
The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary. |
|
|
| Delete Service Area |
/services/{service_id}/service_area/{service_area_id}/ |
DELETE
|
| Reponse Body: (service_area) |
| id |
Each service area must have a unique identifier. |
| service_id |
The identifier of the service for which this entry describes the service area. |
| service_area |
The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary. |
|
|